我的项目是怎么一步步烂掉的,以及我为什么自研 ORM
一、从一个说烂了的话题说起
知乎上隔三差五就有人问:JPA 好,还是 MyBatis 好,还是 MyBatis Plus 好?
吵了这么多年,也没吵出个结论。
原因很简单——每个人的项目不一样,痛点也不一样。用 JPA 的人嫌 MyBatis 写 XML 太累,用 MyBatis 的人嫌 JPA 黑盒太多,用 MyBatis Plus 的人刚开始觉得挺爽,项目做了一两年就觉得哪里不对。
我也在这个问题里纠结了好几年。
后来我发现,其实很多时候大家争论的不是一个技术选型问题,而是一个更深的问题:
数据库访问代码,怎么才能在项目生命周期里一直保持可控?
这个问题比"JPA 还是 MyBatis"重要得多。但很少有人从这角度去想过。
二、我的项目是怎么"烂"掉的
先讲讲我的经历。
我做过不少 Java 项目。有大有小,有单体有微服务。技术栈也从最早的纯 MyBatis,到后来尝试 JPA,再到 MyBatis Plus。
刚开始用 MyBatis Plus 的时候,确实舒服了很多。不用再为每个表写一堆 XML 了,简单的 CRUD 一行代码搞定。
但项目做了半年之后,我发现代码开始变了味。
Service 层里到处是这样的东西:
public List<User> searchUsers(String name, Integer age, String dept) {
LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
if (StringUtils.isNotBlank(name)) {
wrapper.like(User::getName, name);
}
if (age != null) {
wrapper.gt(User::getAge, age);
}
if (StringUtils.isNotBlank(dept)) {
wrapper.eq(User::getDept, dept);
}
return userMapper.selectList(wrapper);
}
看起来没问题对吧?
一个查询两个查询确实没问题。但十个二十个查询呢?
数据库字段名开始大面积出现在 Service 层。
后来新人来了,不知道之前的查询逻辑,又在自己的 Service 里写了一遍类似的 Wrapper。重复代码越来越多,但你想抽公共方法的时候发现——每个查询的条件组合都不太一样,很难复用。
我也试过在 Dao 里写 default 方法封装 Wrapper。Service 确实干净了,但 Dao 里全是模板代码。问题没有解决,只是搬了个地方。
用 JPA 的项目也有类似的问题。简单的用方法名,复杂的用 Specification 或 @Query,再复杂一点就原生 SQL。到最后你会发现,一个项目的数据访问代码散落在至少三个地方:方法名、Specification 类、@Query 注解、还有 xml 里。
分层还在,但边界没了。
这件事让我开始认真思考一个问题:ORM 框架到底应该帮我们解决什么问题?
三、大多数 ORM 解决的是"少写代码",但真正难的是另一个问题
回头看看这些年主流 ORM 框架的演进方向:
- Lambda Wrapper
- Specification
- Criteria API
- QueryDSL
- 链式条件构造器
它们的共同特点是什么?
都是让开发者用 Java 对象的方式来描述查询。
这个方向初期体验确实好。少写 SQL,IDE 有提示,类型安全。
但项目做久了,这些方案慢慢都会出同一个问题:查询逻辑开始扩散。
因为构造查询太方便了,开发者就会在 Service 里随手拼一个。今天拼一个,明天拼一个,用不了多久,数据库访问代码就漏到了 Service 层、Manager 层、甚至 Controller 层。
你去看很多做了两三年的项目,分层架构看起来还在——Controller、Service、Dao,整整齐齐。但仔细看代码:
- Service 里在拼查询条件
- Dao 里要么空的,要么全是 Wrapper 封装
- 复杂报表直接绕过 Dao 写 SQL
形式上的分层还在,但数据访问层的边界已经烂了。
而 ORM 框架对此的态度基本是——不管。它只管帮你少写代码,不管你把代码写在哪儿。
四、所以我自己做了一个
想明白这件事之后,我做了一个决定:自己写一个 ORM 框架。
不是为了造轮子,是因为我确实没找到一个框架能从设计层面解决这个问题。
这个框架叫 MyBatisGX。
它的核心目标不是"少写代码"——虽然实际上代码确实少了很多。它的核心目标是:让查询逻辑收敛到 Dao 层,别让它到处乱跑。
这听起来很虚,我具体讲讲。
1、查询必须收敛到 Dao
MyBatisGX 不提供任何让 Service 层拼数据库查询逻辑的能力。没有 Wrapper,没有 Criteria,没有链式构造器。
想查数据?在 Dao 里定义方法。不管是用方法名:
List<User> findByNameLikeAndAgeGt(String name, Integer age);
还是用 QueryEntity:
@QueryEntity(User.class)
public class UserQuery extends User {
private String nameLike;
private Integer ageGt;
}
List<User> findList(UserQuery query);
都是 Dao 层的事。Service 只管调方法,传参数。
这样做的好处是——如果你想改一个查询的逻辑,你知道去哪里找。就在 Dao 里。不会散落在 Service 的各个角落。
2、定义查询,而不是实现查询
简单查询,用方法名就行,一行定义完事:
User findByName(String name);
List<User> findByAgeBetween(Integer min, Integer max);
Long countByStatusEq(Integer status);
复杂一点的查询,用 QueryEntity,把条件结构化:
@QueryEntity(User.class)
public class UserQuery extends User {
private String nameLike;
private Integer ageGt;
private List<Long> idIn;
}
但更复杂的 SQL 呢?多表关联、统计报表、动态条件?
还是写 SQL。 用 XML、@Statement、@Dynamic 都行。
因为我越来越觉得:SQL 不应该被消灭。 在复杂查询场景下,SQL 反而是最清晰、最直接的表达方式。你用 Java 对象去描述一个五表关联的报表查询,代码量比 SQL 还多,可读性还不如 SQL。
简单的东西简单写,复杂的东西回归本质。
3、保留 MyBatis 的可预测性
我不想让 ORM 变成一个黑盒。所以 MyBatisGX 有几个坚决不做的事情:
- 不做 Persistence Context
- 不做自动脏检查
- 不做隐式级联更新
- 不做延迟加载的暗箱操作
所有 SQL 在启动期就预生成好了,你能看到每一条 SQL 长什么样。如果你觉得哪条 SQL 不满意,直接在 mapper.xml 里覆盖它,XML 优先级最高。
很多大型 JPA 项目到最后都在"禁用这些特性"——关掉级联、关掉脏检查、关掉延迟加载。那为什么不一开始就不做呢?
五、最难的地方不在功能
说实话,做一个 ORM 框架,功能实现反而不是最难的。最难的是取舍。
查询能力要不要开放给 Service 层?
做框架的人都想让框架好用。提供个 Wrapper,Service 层随手一拼就能查,多方便啊。
但方便的代价就是失控。
我在这个问题上纠结了很久。最后决定:不提供。 宁可框架看起来"笨"一点,也不想给数据访问层的腐蚀留口子。
这个决定意味着框架不能用 Wrapper 这种灵活但容易扩散的方式。那怎么办?
方法名查询和 QueryEntity 就是为了解决这个问题——让开发者能用结构化、可复用的方式定义查询,但必须定义在 Dao 层。
方法名查询的解析有多复杂?
方法名查询看起来简单:findByNameLikeAndAgeGt,拆一下就知道是 name LIKE ? AND age > ?。
但真正做的时候你会发现,情况远比想象的复杂:
- 条件之间的 AND/OR 怎么分组?优先级怎么处理?
findByNameOrAgeAndDept到底是(name OR age) AND dept还是name OR (age AND dept)?- 嵌套的条件怎么表达?
- 字段名和关键字怎么准确切分?
findByAge里的 Age 是字段名还是关键字?
光是方法名的解析器,我就重写了三次。
最后用了一种类似 AST 的方式:先把方法名转成 Token 流,再建语法树,最后遍历生成 SQL。支持括号分组,优先级不会出歧义。
QueryEntity 的设计比想象中难
QueryEntity 的思路是:继承实体类,在子类里加带后缀的查询字段。nameLike 就是 name LIKE ?,ageGt 就是 age > ?。
这个设计看起来很直觉。但实现起来要处理的问题不少:
- 字段继承关系怎么处理?父类的字段要参与解析
- 后缀怎么和字段名准确切分?
nameLike切成name+Like还是nameLike+ 什么? @Dynamic动态查询时 null 字段该跳过还是该当 IS NULL 处理?- 类型怎么匹配?
ageBetween应该是 List 类型,但编译期怎么校验?
每一个看起来是小问题,组合在一起就是一堆边界情况。
SQL 预生成的时机
MyBatisGX 的所有 SQL 都是在应用启动时生成的,运行时零开销。但这个决定也让实现变得很难——启动期就必须把所有 SQL 生成正确,运行时再发现问题就晚了。
这意味着框架要在启动阶段完成:扫描实体、解析字段依赖、扫描 Dao 接口、解析方法名、生成 MyBatis 的 XNode、注册到 MyBatis 的 Configuration 里。
整个链路很长,中间任何一个环节出错,应用就起不来。调试和排错的成本比运行时生成高得多。
六、几个工程上的决定
做这个项目的过程中,我做了一些可能"不够潮流"的决定。但每个决定都有明确的理由。
复用了 JPA 的注解,但不引入 JPA 运行时。 @Entity、@Table、@Column、@Id 这些注解语义成熟,开发者也熟悉,没必要再发明一套。但 JPA 的运行时机制——EntityManager、持久化上下文、自动脏检查——一个都不引入。注解只是描述结构,不控制行为。
SQL 可见、可覆盖。 启动期生成的 SQL,可以通过调试模式看到完整的 XML。如果觉得哪条 SQL 不行,直接在 mapper.xml 里写一条同名的,框架生成的那条就失效了。XML 永远是最高优先级。
多数据库方言适配方案。 目前支持 MySQL、Oracle、PostgreSQL。后续会支持更多的数据库。
七、一些真实的感受
MyBatisGX雏形是在18年,经历过4次大版本迭代,最近一年多终于把所有的常用功能都实现了,有些想法想说说。
关于 ORM 的方向。 很多 ORM 框架的优化方向都是"让开发者尽量不碰 SQL"。但我觉得这个方向本身可能就值得商榷。SQL 不是什么需要被消灭的东西。在复杂业务场景下,SQL 是最精确、最高效的表达方式。与其花大力气把 SQL 包装成 Java 对象,不如想想怎么让 SQL 的管理更有序。
关于项目的回退现象。 我见过不少项目,初期用 JPA,中期加 @Query,后期又开始写原生 SQL。也见过用 MyBatis Plus 的项目,绕了一圈又回到了 XML。不是这些框架不好,而是项目的复杂度到了一定程度后,开发者对数据访问的精确控制权变得至关重要。这时候不管用什么框架,最终都会往"能直接写 SQL"的方向回退。
关于"SQL 是一种需要集中管理的资源"。 这个观点是我做 MyBatisGX 过程中越来越坚定的。项目里的每一条 SQL 都应该有明确的归属——属于哪个 Dao、查的是什么、条件是什么。散落在 Service 里的 Wrapper、写在 @Query 注解里的大段 SQL、在代码里拼接的动态 SQL——这些都是 SQL 管理失控的表现。
八、项目现状
MyBatisGX 现在还不算成熟。核心功能已经稳定——CRUD、方法名查询、QueryEntity、分页、关联查询、动态 SQL、逻辑删除、乐观锁这些都有。但文档、测试覆盖、生态都还有很长的路要走。
它不是什么银弹,也不是要取代谁。说白了就是我自己这些年踩了太多坑,想通了一些事情,然后试着用代码把这些想法落地。
有些人做 ORM,出发点是隐藏 SQL。
而我现在越来越觉得,SQL 本身就不应该被隐藏。它需要的是更好的管理方式,而不是更厚的封装层。
